/*
* Copyright (c) 2007, Nubo Technologies
* 
* All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
*
*    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
*    * Neither the name of the Nubo Technologies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package com.nubotech.gwt.oss.client;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * 
 * Access Control Policy associated with a Bucket or Object.
 * 
 * The Access Control List is a sequence of Grants. A grant is composed of one grantee and one permission.
 * @author jonnakkerud
 */
public class AccessControlPolicy {
    
    public static final int PRIVATE = 0;
    public static final int PUBLIC_READ = 1;
    public static final int PUBLIC_READ_WRITE = 2;
    public static final int AUTHENTICATED_READ = 3;
    
    private String ownerId;
    private String ownerDisplayName;
    private List accessControlList;

    /**
     * Returns the Owner ID
     * @return Owner ID
     */
    public String getOwnerId() {
        return ownerId;
    }

    /**
     * Sets the Owner ID
     * @param ownerId The owner ID
     */
    public void setOwnerId(String ownerId) {
        this.ownerId = ownerId;
    }

    /**
     * Gets the owner display name which is typically derived from the users Amazon account
     * @return The owner name
     */
    public String getOwnerDisplayName() {
        return ownerDisplayName;
    }

    /**
     * Sets the owner display name
     * @param ownerDisplayName The owner display name
     */
    public void setOwnerDisplayName(String ownerDisplayName) {
        this.ownerDisplayName = ownerDisplayName;
    }

    /**
     * Return an access control list of Grants
     * @return The access control list
     */
    public List getAccessControlList() {
        if (accessControlList == null) {
            accessControlList = new ArrayList();
        }
        return accessControlList;
    }
    
    /**
     * Sets the access control list of Grants
     * @param accessControlList The access control list
     */
    public void setAccessControlList(List accessControlList) {
        this.accessControlList = accessControlList;
    }
    
    /**
     * Add a grant to the access control list
     * @param grant The Grant to add the the access control list
     */
    public void addGrant(Grant grant) {
        getAccessControlList().add(grant);
    }
    
    /**
     * Returns a list of Grants by type. For example return all "Group" type grants
     * @param type The type of Grant, i.e. "Group"
     * @return The list of grants by type
     */
    public List getGrantsByType(String type) {
        List result = new ArrayList();
        
        Iterator itr = getAccessControlList().iterator();
        while(itr.hasNext()) {
            Grant g = (Grant)itr.next();
            if (type.equals(g.getGrantee().getType())) {
                result.add(g);
            }
        }
        
        return result;
    }
}
